home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 26.zip / BS1 part 26 / Soundtracker v2.6.adf / Soundtracker.DOC < prev    next >
Text File  |  1991-10-09  |  17KB  |  395 lines
  1.  
  2.  
  3. ----------------------------------------------------------------------
  4.  
  5.                           SOUNDTRACKER V2.6
  6.                              User Manual
  7.  
  8. ----------------------------------------------------------------------
  9.  
  10. Last changes to Soundtracker done on  : see program.
  11.  
  12. Soundtracker-Update done by           : MnemoTroN.
  13. Soundtracker-Playroutine by           : Mahoney & Kaktus.
  14. Soundtracker-Playroutine improved by  : MnemoTroN.
  15. Soundtracker-Documentation updated by : MnemoTroN.
  16.  
  17. ----------------------------------------------------------------------
  18.     EVEN IF YOU ARE NOT A FIRST-TIME USER: READ THIS DOCUMENTATION
  19.     CAREFULLY - YOU WILL DISCOVER NEW AND IMPORTANT NEW FEATURES !
  20. ----------------------------------------------------------------------
  21.  
  22. So whattz upp?
  23. --------------
  24.  
  25. *             - Song is now track-orientated
  26.               - 128K samples supported
  27.               - Soundtracker-Interrupts are now legal (no more messing
  28.                 around in the zeropage)
  29.               - Keyboard-presses are now converted with the current
  30.                 KeyMap (except for special keys like Return and so on)
  31.               - Channel-equalizer now shows (nearly) real volume
  32.                 during play
  33.               - General improvements
  34.               - Full workbench support
  35.               - Everything now works with scan-waits (should work fine
  36.                 with Turboboards - could not be tested, though)
  37.               - IFF-Support on loaded files
  38.               - Directory is now dynamic list-based, maximal entries
  39.                 depend on free memory
  40.               - Preconfiguration - save songs/module/sample-directory,
  41.                 IFF-Configuration and size of PresetList to be present
  42.                 at startup
  43. *             - Soundtracker-/System-Switch
  44. *             - improved Speed-Command
  45.  
  46. (*) most important changes
  47.  
  48. The Song.
  49. ---------
  50. The  'Song'  is  build  up  from  tracks.   A 'track' is the note- and
  51. command-data    for    one    channel.     Your    Amiga    has   four
  52. hardware-audio-channels, two on the left side and two on the right.  A
  53. Song  has  128  positions, with each position holding the tracknumbers
  54. for  each  of  the  four channels, so repeated parts will save memory.
  55. Please  note  that the track-number above each voice is represented in
  56. hex.  There are 256 possible tracks in total.  USE TRACK 0 AS AN EMPTY
  57. TRACK!
  58.  
  59. The Keys.
  60. ---------
  61. As  you  may already have read above, Soundtracker now understands the
  62. current  KeyMap-setting when inputting text, so you can configure your
  63. system  as  you like.  The note-keyboard is Sonix-style, try typing on
  64. the  whole  key-rows.   The  keys  on  your Amiga have been grouped to
  65. represent  the layout of a two-octave piano-keyboard.  You can "shift"
  66. the keyboard one octave up or down with the aid of the F1 and F2 keys,
  67. thus incrementing the range of the keyboard to three octaves.
  68.  
  69. Explanation of the options:
  70. ---------------------------
  71.  
  72. MAIN MENU:
  73. ----------
  74. Play     - will play the song whilst showing you the current tracks
  75. Pattern  - plays just the current position
  76. Stop     - stops the player
  77. Insert   - inserts one step at the current position
  78. Delete   - delete the current position - following will move up
  79. Edit     - edit a pattern (switches to edit-menu)
  80. Record   - edit pattern in real-time
  81. Clear    - will kill the song in memory
  82. Use Pset - will load a sample, which can be chosen with the Preset-
  83.            gadget
  84. Filter   - will switch the Power-LED (and lowpassfilter on selected
  85.            machines) on and off
  86. Disk Op  - switches to the Disk-Menu (see below)
  87. Print    - will print the Songheaderdata to PRT: (right button to
  88.            abort)
  89. Pset-Ed  - switches to the PresetList-Editor (see below)
  90.  
  91. The small gadgets titled from 1 to 4 represent the four audio channels
  92. of  your  Amiga  computer.   When lit, the respective audio channel is
  93. enabled.
  94.  
  95. DISK MENU:
  96. ----------
  97. Load Song      - loads a song
  98. Save Song      - crunches and saves a song
  99. Delete Song    - deletes a song from the disk
  100. Load Module    - loads a module
  101. Save Module    - saves a module
  102. Delete Modules - deletes a modules from the disk
  103. Load Sample    - read a sample from any disk
  104. Save Sample    - save the selected sample to disk
  105. Format Disk    - formats a disk
  106.  
  107. To  change the path of song/module/sample without reading it, move the
  108. cursor  to  the uppermost line of the screen over one of these options
  109. and  press the left mousebutton.  The directory-display will change to
  110. this option.
  111. Please  note  that  the Format-Option has been improved and should now
  112. work 100%.
  113.  
  114. PRESETLIST-EDITOR:
  115. ------------------
  116. Edit       - to edit an entry (see below)
  117. Insert     - inserts an entry into the PresetList
  118. Delete     - deletes an entry
  119. Read path  - reads the specified path and inserts the entries into the
  120.              list
  121. Print Plst - lists the PresetList to PRT: (right button to abort)
  122. Save Plst  - saves the PresetList to disk
  123. Use Pset   - loads a selected sample into the memory
  124.  
  125. Press the right mousebutton to move up and down faster!
  126.  
  127. The  'Edit'-option  is not included in the menu.  Just click on one of
  128. the  entries and you can change the name or the other values.  To read
  129. a  sampledisk using 'Read path' you have to enter the path you want to
  130. read  (in  most  cases  'df0:' to 'df3:').  Harddisk users may enter a
  131. volume-number  which will be inserted before the samplename.  Click on
  132. 'Volume'  to  change  it.   Disks  with  a  name  like 'ST-xx' will be
  133. automatically identified!
  134.  
  135. Preferences menu:
  136. -----------------
  137. Press  Shift+HELP  in  the  main  menu  to enter the Preferences menu.
  138. Click  on  the  lines  showing  the  song/module/sample-directories to
  139. change   them.   Click  on  'IFF-Check'  to  change  the  IFF-Checking
  140. (none/half/full).   Click  on  Max  Entries  to  change  the number of
  141. entries  in  the  presetlist.   If  you  change the number of entries,
  142. Soundtracker will try to reload the PresetList with the desired number
  143. of entries.
  144.  
  145. Press ESC to quit the menu or Shift+ESC to save & quit.
  146.  
  147. IFF-Checking:
  148. -------------
  149. Normally,  if  Soundtracker encounters an IFF-Samplefile, it will load
  150. the  data,  remove  the  IFF-Header  and  set  the  Length, Repeat and
  151. Repeatlength according to the data given in the IFF-File.  This should
  152. normally work fine, but if you have changed the values in the song and
  153. load  it  afterwards,  the  values  you changed will be overwritten by
  154. those in the IFF-File.  To prevent this, set IFF-Check to 'half'.  Now
  155. only   the   IFF-Header  will  be  removed,  but  Length,  Repeat  and
  156. Repeatlength will not be affected.
  157. Due  to  a  bug in old versions of NoiseTracker (hehe), a module saved
  158. with  it which uses IFF-Files will have the IFF-Headers saved with it,
  159. but  not  the  end  of  the  samples.   Soundtracker  will  remove the
  160. IFF-Header  and  will try to copy the sample-data over it, but because
  161. some bytes are missing, there can be strange noises at the end of such
  162. a sample.  If you encounter such a module, you should set IFF-Check to
  163. none, this may result in a strange noise (VERY short) at the beginning
  164. of the sample.
  165.  
  166. All time key-commands:
  167. ----------------------
  168.                 Tab - Pattern Play / Play Pattern (in Edit-Mode)
  169.         Right Amiga - Edit Pattern
  170.               Space - Stop
  171.  
  172. While editing:
  173. --------------
  174.                Cursor-keys move cursor.
  175.        shift + Cursor-keys move cursor fast.
  176.          alt + Cursor-keys move cursor fastest.
  177.                F6  - Set cursor to first line of pattern.
  178.                F7  - Set cursor to 16th line of pattern.
  179.                F8  - Set cursor to 32th line of pattern.
  180.                F9  - Set cursor to 48th line of pattern.
  181.                F10 - Set cursor to 63rd line of pattern.
  182.                DEL - Delete note under cursor.
  183.        shift + F3  - Cut track of current channel and copy it into a
  184.                      buffer.
  185.        shift + F4  - Copy track of current channel into a buffer.
  186.        shift + F5  - Copy buffer to track of channel pattern.
  187.          ctrl + B  - Mark beginning of block
  188.          ctrl + C  - Clear from beginning to current cursor-position
  189.          ctrl + X  - Cut from beginning to current cursor-position
  190.          ctrl + V  - Copy from beginning to current cursor-position
  191.          ctrl + P  - Paste from buffer to current-position
  192.  
  193. While using Soundtracker V2.6, HELP will show you these commands, plus
  194. information  about  the  song-,  sample-  and  module-length  and free
  195. memory.
  196.  
  197. A  small  word  about  the  +/-  gadgets:  pressing the left AND right
  198. mousebutton will in-/decrease the value faster !!
  199.  
  200. Sample zero function:
  201. ---------------------
  202. While  editing  you're  able to set the sample to the value zero (0!).
  203. Press  both  mousebuttons  at the position of the samplegadgets (plus,
  204. minus  =  +,-).   Now  you  can  edit the pattern with the sample 0 to
  205. prevent difficulties according to the volume.
  206.  
  207. Instruments.
  208. ------------
  209. You  can use up to thirtyone different instruments in one music-piece.
  210. All instruments are listed in the preset-list.  The volume is normally
  211. $40, but you can change it to each value between 0 and $40.  To change
  212. the   other   values   of  each  instrument  you  have  to  enter  the
  213. preset-editor  or  use  the  gadgets  in the program (this is only for
  214. small  changes.  use the preset-ed otherwise!).  With the PresetEd you
  215. can  change  the  whole preset-list.  An instrument may have a maximal
  216. length  of  128K  !!   Due  to this enhancement the Length, Repeat and
  217. Repeat-Length  display  the length in WORDS !!  Multiply by two to get
  218. the length in bytes.
  219.  
  220. Notes:
  221. ------
  222.                C#1  0 3 C 2 3
  223.                /    |/  |  \|
  224.               /     /   |   Par
  225.              /     /  Command
  226.             /    Inst#
  227.          Note to
  228.          be played.
  229.  
  230.  
  231. Note:     This is simply the note that is played with that particular
  232. -----     instrument.
  233.  
  234. Inst#:    This is the number of the instrument that is used to play
  235. ------    that note.  When the  instrument number is zero, the last
  236.           selected instrument will be used.
  237.  
  238. Command:  This number tells Soundtracker what special functions shall
  239. --------  be performed while playing the note.
  240.  
  241. Par:      This byte contains the parameter(s) for the command.
  242. ----
  243.  
  244. These functions are as follows:
  245.  
  246.     0 - Normal play or arpeggio.
  247.     1 - Portamento up.
  248.     2 - Portamento down.
  249.     3 - Tone-portamento
  250.     4 - Vibrato
  251.     A - Volume slide.
  252.     B - Position jump.
  253.     C - Set volume.
  254.     D - Pattern break.
  255.     E - Set filter on/off.
  256.     F - Set speed.
  257.  
  258.  $0 Arpeggio  -  $0 + second halfnote-add + third halfnote-add
  259.       This command will produce a one-channel chord. No comments.
  260.      C-3 00037   produces a minor-chord
  261.      C-3 00047   produces a major-chord
  262.  
  263.  $1 Portamento up  -  $1 + portamentospeed
  264.       This commans slides the pitch up.
  265.      C-3 00103   1 is the command, 3 is the speed.
  266.  
  267.  $2 Portamento down  -  $2 + portamentospeed
  268.       This command slides the pitch down.
  269.      C-3 00203   2 is the command, 3 is the speed.
  270.  
  271.  $3 Tone-portamento  -  destination-note + $3 + speed
  272.       This will automatically slide from the old note to the new.  To
  273.       keep on sliding, just select the command 3. Try it out yourself,
  274.       and I'm sure you'll understand a little bit better.
  275.      C-3 00305   C-3 is the note to slide to, 3 the command and 5 the
  276.                  speed.
  277.  
  278.  $4 Vibrato  -  $4 + vibratospeed + vibratosize
  279.      C-3 00481   4 is the command, 8 is the speed of the vibrato and 1
  280.                  is the size of the vibrato.
  281.                  To hold vibrato just select the command 4 without
  282.                  parameters.
  283.  
  284.  $A Volume-slide  -  $A + upslidespeed + downslidespeed
  285.      C-3 00A05   5 is the speed to turn down the volume
  286.      C-3 00A40   4 is the speed to slide it up.
  287.  
  288.  $B Position-jump  -  $B + song-position to continue at
  289.      C-3 00B01   1 is the place to restart the song at.
  290.       This command will also perform a pattern-break.
  291.  
  292.  $C Set volume  -  $C + new volume
  293.       Well, this old familiar command will set the current volume to
  294.       your own selected. The highest volume is $40. All volumes are
  295.       represented in hex. (Programmers do it in hex, you know!)
  296.      C-3 00C10   C is the command, $10 is the volume (equals 16).
  297.  
  298.  $D Pattern-break  -  $D + nothing
  299.       Sure simple, this magic thing will end your pattern and go on
  300.       with the next one. This line will be played!!
  301.      C-3 00D00   D in one track, all others are a waste of memory.
  302.  
  303.  $E Set filter  -  $E + filter-status
  304.       This command jerks around with the sound-filter on some A500
  305.       and A2000. This command shouldn't be used anymore !!
  306.      C-3 00E01   disconnects filter (turns LED off)
  307.      C-3 00E00   connects filter (turns LED on) * please keep LED off!
  308.  
  309. NEW AND IMPROVED:
  310.  $F Set speed  -  $F + speed1 + speed2
  311.       This will change the speed of your tune. (how fast your patterns
  312.       will roll ...) Speeds from $01 - $0f are allowed.
  313.      C-3 00F07   sets speed to 7
  314.      C-3 00F70   sets speed to 7
  315.      C-3 00F34   speed will change with every step to 3,4,3,4,3 and so
  316.                  on  (this was inspired by looking at the 'Kill Victor
  317.                  Theme' and 'Chicago Song',both by Nightlight/Kefrens.
  318.                  Nice idea, pal) Speed 3/4 will result in an effective
  319.                  speed  of  3.5.   Please  note  that 3/4 and 4/3 will
  320.                  behave different and also note that if you do Vibrato
  321.                  with  the  slide-command, the slided pitch depends on
  322.                  the speed (try the same slide for both speeds and the
  323.                  pitch will raise/lower).
  324.                  The even  lines (0/2/4/6..)  will  last  for <speed1>
  325.                  frames,  the odd  lines  (1/3/5/7..)  will  last  for
  326.                  <speed2> frames.
  327.  
  328. For your convenience the speed is set to 6 everytime you load a song/
  329. module or clear the song.
  330.  
  331. The Playroutine.
  332. ----------------
  333. On the original Soundtracker V2.6 release disk is a source code, which
  334. has to be used if you want to use a piece of music created with Sound-
  335. tracker in your own programs.
  336.  
  337. How to incorporate a module into your own programs:
  338. ---------------------------------------------------
  339. 1) Save the  music you  want to  use with  the SAVE MODULE-function in
  340.    Soundtracker.  You now  have  a so-called  'MODULE', which contains
  341.    both the song- and the sample-data.
  342. 2) Load your favourite assembler.
  343. 3) Load the Player-Source.
  344. 4) If you use SEKA, don't bother.  If you use GenAm,  change the 'blk'
  345.    statements at the end of the source to 'dcb' (sic!).
  346. 5) Now you  have to  insert the  module into  your source  (or better:
  347.    memory). This can be done in different ways:
  348.    1) Load the module to an absolute address (bad habit).
  349.    2) With Seka:  reserve a chip-memory-block  representing the length
  350.       of the module with 'blk.b' and
  351.       1) 'ri' the module-file to the address after assembling the
  352.          source or
  353.       2) >EXTERN the file and read the data with 'y' after assembling.
  354.    3) With Devpac:  INCBIN the module-file in chip-memory (use SECTION
  355.       if required)
  356. 6) Call the  'mt_init' routine  with the  address of the module in A0.
  357. 7) Every  frame (50 times a second)  call 'mt_music'.  You should hear
  358.    the music now.
  359. 8) To stop  the music,  stop calling  'mt_music',  then call  'mt_end'
  360.    (once).
  361.  
  362. ----------------------------------------------------------------------
  363.  
  364. Soundtracker and Workbench(tm):
  365. -------------------------------
  366. All  Workbench-fanatics  can  start  Soundtracker  from  the Workbench
  367. without  using utilities like XIcon.  Simply use the provided icon (or
  368. draw  your  own),  but  remember:   don't  forget to assign the ST-xx:
  369. disks!   There  should  be  however  no  problems  with  Workbench and
  370. Soundtracker working together because Soundtracker disables all Mouse-
  371. and Keyboard-Functions while active.  The current directory is the one
  372. Soundtracker  has  been  started from which also applies to the CLI !!
  373. The PLST and configuration-file will be read from that path.
  374.  
  375. Soundtracker and Multitasking:
  376. ------------------------------
  377. In  Soundtracker  V2.6  you can easily switch between Soundtracker and
  378. the  Amiga  Multitasking  Environment,  by pressing the Left Amiga key
  379. plus  the letter S(witch).  I think there shouldn't occur any problems
  380. with  other programs running in the background, but I recommend not to
  381. use  any  other  programs  when using Soundtracker.  Soundtracker uses
  382. vast  amounts of processor-time (due to bad programming), so don't run
  383. applications which depend on it (time, not Soundtracker!).
  384.  
  385. ----------------------------------------------------------------------
  386.  
  387. Last,   but   not   least,  many  thanks  to  all  people  who  tested
  388. Soundtracker,  made  suggestions  for  changes and reported bugs (have
  389. there been any?) to me.  Sorry that I don't list you by name, but some
  390. I don't remember and nobody shall be preferred, ok?
  391.  
  392. MnemoTroN, 03-Nov-90
  393.  
  394. -EOF-
  395.